﻿///////////////////////////////////////////////////////////////////////////////
//
// This file is part of the BassDrop project
//   https://code.google.com/p/bass-drop/
//
//
// Creator:	Gergely Krajcsovszki (krajcsovszkig@hotmail.com)
// Date:	2013-08-05 12:45
//
//
// Copyright © 2013-2014. Gergely Krajcsovszki
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
///////////////////////////////////////////////////////////////////////////////
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace BassDrop.Core.Common.Options.Items
{
	/// <summary>
	/// OptionsItem for actions
	/// </summary>
	public class ActionOptionsItem : OptionsItemBase
	{
		/// <summary>
		/// Delegate type for actions that can be invoked on the click of the button
		/// corresponding to this item
		/// </summary>
		public delegate Task ActionDelegate();

		/// <summary>
		/// The method invoked when the button is clicked.
		/// </summary>
		public ActionDelegate Action
		{
			get;
			private set;
		}

		/// <summary>
		/// Creates a new action options item
		/// </summary>
		/// <param name="action">The method invoked when the button is clicked.</param>
		/// <param name="name">Name/title of the item</param>
		/// <param name="description">The description of the item. Shown typically in tooltips</param>
		public ActionOptionsItem( ActionDelegate action, string name, string description )
			: base( name, description )
		{
			Action = action;
		}
	}
}
